home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / os20 / util / comixbase250.lha / Comix / CB250.DOC next >
Text File  |  1992-06-14  |  13KB  |  287 lines

  1.                                Comixbase 2.50
  2.                                     by
  3.                                Terence Russell
  4.  
  5.                            trussell@sun.cuug.ab.ca
  6.                           russell6112@mtroyal.ab.ca
  7.  
  8. What is Comixbase?
  9. ==================
  10.     Comixbase is a custom database for small comic collections (max 65535).
  11.     It requires Workbench V36 or greater (Thats WB 2.0 to you and me).
  12.     (If you're still using WB 1.3 or lower ... GET A LIFE! :-)
  13.     (Included in the archive is a sample Comixbase database. This is included
  14.      to give you an idea of how the database could be setup. To start your
  15.      own database run the program CBI101).
  16.  
  17. Legal Crap
  18. ==========
  19.     At the very end of this text where it belongs!
  20.  
  21. What are Cbase's features?
  22. ==========================
  23.          * 65535 maximum comic collection size.
  24.          * 3500 maximum number of text strings in each text category.
  25.            (Based on an average of 20 characters per string.)
  26.          * Sort by Title (prime key) and Issue (secondary key).
  27.          * Generate compact report:
  28.             eg Action: 10-24,45,48,111-113
  29.          * Reports the collection size and value.
  30.          * Keep track of 9 artists in 3 fields: Writer, Penciller, Inker.
  31.          * Two note strings for detailed information on a comic.
  32.          * 6 line buffers to reduce entering repetitive data.
  33.          * Fully Intuitionized interface.
  34.  
  35.     For each comic the following information is stored in various data fields:
  36.  
  37.     * Title
  38.     * Publisher
  39.     * Special (IE: Annual, Summer, Limited, Gfx Novel)
  40.     * Note (This field is meant to be used for anything however I use it
  41.         for the odd comic which may need an extra description.
  42.         IE: Silver edition/bagged/Spidey UPC).
  43.     * 9 artist fields which breaks down into 3 Writer fields, 3 Pencilers,
  44.         and 3 Inker fields.
  45.     * All of the above mentioned fields may be up to 40 characters in length.
  46.     * Issue (This field includes the issue number as well as the number
  47.         of copies of this comic which are owned up to 31).
  48.     * Date (This field is divided into 3 parts: Time In The Month, Month,
  49.         and Year. Time In The Month can be 1 of 3 words, "early, mid, or late",
  50.         and can be excluded. The Month part is the first 3 letters of a
  51.         month and can be excluded only if the Time In The Month field has been
  52.         excluded. The Year part must be present and is a value from 1900 to
  53.         2155. You may enter the year as a value from 0 to 255, but a value of
  54.         1900 is added to that.)
  55.     * Value (This field holds a dollar value from 0.00 to 655.35. Obviously
  56.         I'm using a 2 byte fixed point representation.)
  57.  
  58.     All of the above fields add up to quite a bit of information for each
  59.     comic and using a general database which contains all those fields, you
  60.     would end up with some huge data files. In fact I originally used
  61.     Superbase Personal (TM) and found that when I wanted to add the 9 artist
  62.     fields the data files blew up from 50K to 140K. The database also became
  63.     quite slow (even running from a ram drive). When I created this program
  64.     (circa Feb. 91) and moved all the information over to this format that
  65.     140K file shrunk down to 45K.
  66.     (How that was achived will be explained in another text.)
  67.  
  68. What about functions?
  69. =====================
  70.     Currently (2.50) the database has 4 main functions (one of which I would
  71.     like to make hidden and automatic, but would also like to add a function
  72.      which is currently supported by an external file.):
  73.  
  74.     * First and quickest of the functions is [Total Value]. This function
  75.       quickly goes through the entire list counting the number of comics and
  76.       adding up their values. This function takes into account duplicates.
  77.  
  78.     * Second is the [Issue Report] function which creates an ascii formatted
  79.       Report file on the RAM: drive. It is a Title/Issue report for the
  80.       entire database and has the following format:
  81.           Action Comics: 444-450,461,475-490,492,494
  82.           Dark Horse Presents: 30-47,49
  83.           etc.
  84.       It only shows you what you have in terms of runs on each title.
  85.       (This of course can be easily expanded in the near future.)
  86.  
  87.     * Third is a Sort function which will put the database into a Title/Issue
  88.       order and will update the index. This is used after each session of
  89.       adding new comics. (I will soon make this an automatic function.)
  90.  
  91.     * Finally the largest and most important function is Edit.
  92.       This function allows you to do detailed editing of individual comics.
  93.       Here is where you will add new comics, delete comics no longer in your
  94.       collection, and edit old comics to reflect new prices or whatever.
  95.  
  96. Using the Edit function.
  97. ========================
  98.     Within the editor you may do 3 things, movement through records, record
  99.     editing, and record deletion.
  100.  
  101.     Movement
  102.     ========
  103.         There are 3 types of movement in Comixbase:
  104.  
  105.         * First is single stepping using '-' and '+' or their gadget equivalents
  106.           of '-prv' and 'nxt+'. Single stepping allows the user to move to
  107.           the next or previous comic record.
  108.  
  109.         * Second is title jumping using the left and right arrow keys or
  110.           the gadgets labelled '<<--' and '-->>'. This allows the user to
  111.           quickly move to the first or last issue of the next or previous
  112.           title.
  113.  
  114.         * Third is the specific Title/Issue search using 'f' or the gadget
  115.           labelled 'Find'. This movement asks the user for the title to
  116.           search for and an issue number to stop at.
  117.           The title can be wild carded so that "j*l*eur*" will find in my
  118.           collection the title "Justice League Europe".
  119.           The program will stop at the issue number given by the user if it
  120.           finds a match, or will stop at the issue number which is closest
  121.           to it.
  122.  
  123.     Editing
  124.     =======
  125.         Editing itself breaks down into 3 types:
  126.  
  127.         * First is a Straight edit of the currently displayed comic.
  128.           With the Straight edit you simply change the field data of this
  129.           comic record. This is useful for updating the comic's value.
  130.  
  131.         * Second is the Copy edit which allows you to create a copy of
  132.           the currently displayed comic and then save it as a totally new
  133.           comic. This is very useful when adding a comic to the collection
  134.           which has data that is found in another comic. (This cuts down on
  135.           your typing.) Typically this would be used when you have (for
  136.           example) Flash 47 and you want to add to the database Flash 48,
  137.           all you would have to do is copy Flash 47 and make some minor
  138.           changes and then save it as Flash 48.
  139.  
  140.         * Third is the New edit which clears all fields and allows you to
  141.           start with a clean slate (so to speak). Once you've added all the
  142.           data for this new comic simply save it and there will be a new
  143.           comic record in the database.
  144.  
  145.         --- STARTING AN EDIT MODE ---
  146.         You may go into any one of these three editing modes by selecting
  147.         the appropriate gadget or by pressing 'e', 'c', or 'n' on the
  148.         keyboard. Another way to start up the Straight editing mode is by
  149.         moving the mouse over top the comic record and clicking the left
  150.         button.
  151.  
  152.         --- CURSOR MOVEMENTS ---
  153.         Once in either of the three modes you may move the cursor around
  154.         by using the arrow keys, the return key, or by pointing and clicking
  155.         with the mouse. The cursor will not appear in an area where there is
  156.         no data (with the exception being the very end of the data in a data
  157.         field.)
  158.  
  159.         --- FINISHING AN EDIT MODE ---
  160.         To save any changes or to save a new comic record click on the "Save"
  161.         gadget or press "Ctrl S". To escape without making any changes from
  162.         the edit modes click on the "eXit" gadget or press the ESCape key.
  163.  
  164.         --- DELETING CHARACTERS ---
  165.         The backspace key deletes to the left of the cursor.
  166.         The Del key deletes under the cursor and to the right.
  167.  
  168.         --- CHANGING A FIELDS DATA ---
  169.         If you make a change to a field you must press the return key after
  170.         you are done with that field. This is to let the program know
  171.         that it must update database with regard to that field.
  172.         (You do not have to do this if you selected the New editing mode.)
  173.  
  174. * * * * --- USING THE EDITING MODE BUFFERS ---
  175.         With the editing mode buffers you may store or retrieve the data
  176.         for an entire field. There are 6 buffers and initially they are empty
  177.         and represented by the string '----'. When a buffer contains data it
  178.         is represented by the string 'data'. To find out what is stored in a
  179.         buffer simply click on it and its contents will be displayed.
  180.  
  181.         --- STORING DATA INTO A BUFFER ---
  182.         To store a field's data in a buffer, first position the cursor on the
  183.         field you wish to store. Next click on the 'Stor' gadget and then
  184.         click on any one of the six buffers where you would like to store the
  185.         information.
  186.  
  187.         If the buffer was previously empty it's text will change from '----'
  188.         to 'data' and the data which was stored in that buffer will be
  189.         displayed. If the buffer previously contained data, that data will
  190.         have been wiped out and replaced by the new data.
  191.  
  192.         --- CLEARING A BUFFER ---
  193.         If you store a blank or empty field (one containing nothing, not even
  194.         space characters) in a buffer which contains data, that buffer will
  195.         be emptied and the text 'data' with be replaced by '----'.
  196.  
  197.         --- RETRIEVING DATA FROM A BUFFER ---
  198.         To retrieve data from a buffer, position the cursor anywhere on the
  199.         field where you would like to copy the buffers data and then click on
  200.         the 'Rtrv' gadget, the cursor will disappear. Next click on the
  201.         buffer containing the data you wish to retrieve. The data will have
  202.         been copied to the field.
  203.         (Remember to save the comic record once you are done with it.)
  204.  
  205.         --- NON-RETENTION OF BUFFER DATA ---
  206.         The buffers will only retain their data while you are using the
  207.         Edit FUNCTION. If you exit to the main menu and then use the Edit
  208.         FUNCTION again the buffers will all be empty.
  209.  
  210.         --- CANCELING A BUFFER OPERATION ---
  211.         At anytime during either a store or retrieve operation if you would
  212.         like to cancel that operation, simply click on some place within
  213.         Comixbase's window and if the cursor reappears the operation has
  214.         been aborted.
  215.  
  216.     Record Deletion
  217.     ===============
  218.         To remove a comic record from the database (either because you no
  219.         longer have the comic or the record was added by accident) press 'd'
  220.         or click on the gadget 'Del'. The program will then ask you if you
  221.         really want to delete the comic. Press 'y' or 'n', or click on the
  222.         'Y' or 'N' gadgets.
  223.  
  224.         The comic data is not really removed from the database, its just made
  225.         inaccessable to you the user. The reason for this is because removing
  226.         immediately would require creating new database data files. Instead
  227.         that task is left for the restructuring program CBR164 (current).
  228.         (In the near future I want to incorporate CBR into Comixbase as a
  229.          main menu function.)
  230.  
  231. Miscellaneous
  232. =============
  233.  
  234.     * The program adjusts its display window upon starting up for the system
  235.       font (the menu bar font).
  236.     * The program will attempt to use for its main font the 8 point font
  237.       called System. If this font is not available it will default to
  238.       the ROM font Topaz 8.
  239.       This font can be found in the COMIX directory. To install it in your
  240.       FONTS: directory, copy it from the command line with the command:
  241.  
  242.         copy sys#? to fonts:
  243.  
  244.     * In an 8 colour (3 bitplane) environment the program makes use of one
  245.       extra pen. The default colour of this pen may make the text
  246.       unreadable. In that case the colour I use is a pastel yellow which
  247.       looks quite nice.
  248.     * I would like to add menus, default settings, non-english language
  249.       support, an on-line help mode, more reports, comic record buffering,
  250.       make the restructure program a function of Comixbase, and other
  251.       goodies.
  252.  
  253. Legal Crap ® & ©
  254. ================
  255.     This program is copyrighted in all but 49 of the 50 American states.
  256.     (The copyright is of course void where prohibited.)
  257.  
  258.     This program may not be used in anyway by people who are associated with
  259.     creating weapons. (Unless of course the weapons are really destructive!)
  260.  
  261.     Not in anyway affiliated with BLAZEMONGER Inc. © Dan Barrett
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.     "Thank God!"
  287.